Description
POST: api/{VaultName}/files/buildtree/checkout Build checkout references tree
Gets the tree of references in the specified file's checkout.
Parameters
| Name | Description | Data Type |
|---|
| vaultName | (URI parameter) Valut name (required) | string |
| FileId | (Body parameter) File ID
Member of CheckOutItem; see Remarks | integer |
| FolderId | (Body parameter) Folder ID
Member of CheckOutItem; see Remarks | integer |
| File | (Response) A FileInfoConfigLess object that consists of:
File (File object consists of:
FileId (integer)
FileName (string)
)
Folder (Folder object consists of:
FolderId (integer)
FolderPath (string)
)
Version (integer)
Member of FileRefOfFileInfoConfigLess model; see Remarks | FileInfoConfigLess |
| IsToolbox | (Response) Whether is a toolbox item
Member of FileRefOfFileInfoConfigLess model; see Remarks
| integer |
| ObjectType | (Response) PweObjectType model; one of:
ObjType_NoObject = 0
ObjType_File = 1
ObjType_InternalComponent = 2
ObjType_SavedBOM = 3
ObjType_Item = 4
ObjType_CutListItem = 5
Member of FileRefOfFileInfoConfigLess model; see Remarks
| String |
Request (application/json, text/json)
Sample Data
[
{
"FileId": 1,
"FolderId": 2
},
{
"FileId": 1,
"FolderId": 2
}
]Request (application/xml, text/xml)
Sample Data
<ArrayOfCheckOutItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
<CheckOutItem>
<FileId>1</FileId>
<FolderId>2</FolderId>
</CheckOutItem>
<CheckOutItem>
<FileId>1</FileId>
<FolderId>2</FolderId>
</CheckOutItem>
</ArrayOfCheckOutItem>Request (application/x-www-form-urlencoded)
Response (application/json)
Response (text/json)
Response (application/xml)
Response (text/xml)
See Also